In general, keywords may be given in any order, except that a varlist specification (for a plain text codebook ONLY) is assumed to refer only to the preceding specification of the SDA study or DDL file or IDL file. (See the section below on ‘Study/DDL and Varlist Repetition’ for a discussion of this issue.)
The valid keywords are as follows (with significant characters shown in capital letters):
TYPE OF CODEBOOK TO CREATE
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
TYPE= HTML [create HTML files] PRINT2SIDE
TAGGED1SIDE [for MS Word,
1-sided printing]
TAGGED2SIDE [for MS Word,
2-sided printing]
PRINT1SIDE [Plain text for
1-sided printing]
PRINT2SIDE [Plain text for
2-sided printing]
SOURCE OF THE DATA
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
(Only one of the following three keywords can be used in the same run.)
STudy= path of dataset directory Look for variables only
in current directory
(or in a DDL/IDL file)
DDL= name of DDL file Look for an SDA dataset
IDL= name of IDL file Look for an SDA dataset
(sets program to IDOC mode)
VARIABLE LIST AND TEMPLATES
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
VARlist= filename of list of variables All variables in
alphabetical order
(for an SDA study)
or in the order found
(in a DDL/IDL file)
GROUPsfile= name of file with group names No extra variable groups
and variables in each group
(HTML output only)
TEmplate= filename containing Default template used
template(s)
OUTPUT LOCATIONS
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
SAvefile= directory/prefix for output (if HTML:) hcbk
(see note for HTML filenames) (in current directory)
(if tagged or plain text:)
XCODEBK.TXT
Errorfile= filename to receive messages XCODEBK.MSG
about errors and warnings
SOURCE OF INTRODUCTORY AND APPENDIX TEXT
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
INTro= filename(heading) No introduction
for intro material
(can be repeated)
Appendix= filename(heading) No appendix
for appendix
(can be repeated)
CBTEXT= directory in which to find SDA study directory
the /CBTEXT subdirectory (for SDA input)
(for supplementary text) or current directory
(for DDL/IDL input)
TItle= filename of title page Default title page
FILTER AND WEIGHT VARIABLES
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
FILTer= names and codes of filter No selection filter
variables; for example:
filter=gender(1),age(18-50)
(can be repeated)
(ignored for DDL/IDL input)
Weight= name of weight variable No weighting for
(ignored for DDL/IDL input) frequencies or stats
VARIABLE FOR A STRATIFIED CODEBOOK
(Stratified codebooks are only available in HTML format.)
(Only one of the following two keywords can be used in the same run.)
ROWVAR= name of stratifying variable No row stratifier
COLUMNVAR= name of stratifying variable No column stratifier
(If ’all’ is given after the name of the stratifying variable, then
all categories of the stratifying variable are shown. Otherwise,
the categories with missing data are excluded.
For example: ’rowvar=year all’.)
PROCESSING INSTRUCTIONS
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
LANGfile= name of file with non-English English labels on
labels and messages output
MAXCat= max number of categories SDA input: 40 rows
to display or 20 columns
DDL or IDL input:
all with labels
NOCASE= YES (Ignore case in matching Distinguish upper and
item names for hypertext lower case item names
references in an HTML IDOC)
PCt= EXCLUDE [missing data in pcts] EXCLUDE [missing data]
INCLUDE [missing data]
BOTH [kinds of percents]
NOPCT [no percentages]
NONUM [no frequencies
or percentages]
(all ignored for DDL/IDL input)
SYSMDlabel= Label for system missing-data (No Data)
(ignored for DDL/IDL input)
(overrides the "SYSMIS_LABEL"
string in the Language File)
OPTIONS FOR HTML OUTPUT ONLY
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
HLINK= filename with external links
HSIZE= maximum file size 100
(in 1000’s of bytes)
HEADER= name of file for header No logo or link put at
text or for logo top of title page and
main index pages
FOOTER=
FRAMes= NO (Create codebook Codebook created with
without HTML frames) HTML frames so the
links in table of contents
are always available
FORMATING FOR A PLAIN TEXT FILE (ignored for tagged and HTML)
Keyword Possible Specification Default (if no keyword)
_____________________________________________________________________
LINelength= number of characters in a line 72
(not counting left margin)
MARgin= number of spaces for 6
left margin
PAgelength= maximum page length (lines) 60
For codebooks in plain text format, up to five studies (or DDL or IDL files) can be specified for inclusion in a single codebook. However, if weight or filter variables are used for the codebook, all of the studies must have the same number of cases. (Weight and filter specifications are ignored if DDL or IDL files are specified instead of SDA study datasets.)
If multiple input studies (or DDL/IDL files) are specified, the ‘study=’ (or ‘ddl=’ or ‘idl=’) and ‘varlist=’ keywords may each be repeated. The order in which they appear is important: the specification of the varlist for a study (or DDL/IDL file) must FOLLOW the specification of that study (or DDL/IDL file) and precede the specification of any other study (or DDL/IDL file).
For example, in the following command file the varlist for the "faculty" study will be "flist" and the varlist for the "students" study will be "slist": The name for each study is the pathname of the study directory, and the name for each list is the pathname of the file containing the list of variables. In the form given in this example, both studies would have to be subdirectories of the current directory, and both lists would have to be located in the current directory.
study = faculty varlist = flist study = students varlist = slist
If an SDA study is specified without a matching varlist, all variables in the study will be included in the codebook, in alphabetical order. If a DDL or IDL file is specified without a matching varlist, all variables in the DDL or IDL file will be included in the codebook, in the order in which they are found in the DDL or IDL file.
If a varlist is specified without a preceding ‘study=’ or ‘ddl=’
or ‘idl=’ specification, the list is assumed to apply to an SDA
dataset located in the user’s current directory.
Repetition of ‘study=’, ‘ddl=’, ‘idl=’ and ‘varlist=’ keywords are also allowed, as described above; however, ‘study=’, ‘ddl=’, and ‘idl=’ specifications cannot be mixed for the same codebook.
Multiple filter variables can be specified either by including more than one on the line after ‘filter=’ or by using multiple ‘filter=’ lines. (Filter specifications are ignored for DDL/IDL input.)
If other keywords are repeated, an error message will result.
type = tagged2side study = natlrace varlist = rvarlist savefile = rcodebk.txt template = template.cb title = titlefile intro = introfile # Both appendix headings will go into the table of contents # The second heading will also go into the body of the codebook # as a heading for that appendix (because of the ’**’). appendix = appA(Sample Description) appendix = appB(**Description of Weighting Procedures) # Shows codes as ‘.’ that were blank in the original data file. # Label them ’Blank - Does Not Apply’. SYSMDlabel = Blank - Does Not Apply
type = tagged2side DDL = nrace.ddl varlist = rvarlist savefile = rcodebk.txt # Note that any template references to ‘statistics’ or # ‘date’ (date of creation of SDA variable) will be ignored. template = template.cb title = titlefile intro = introfile appendix = appA(Sample Description) appendix = appB(**Description of Weighting Procedures)
type = tagged2side study = natlrace varlist = rvarlist savefile = rcodebk.txt template = template.cb weight = casewt filter = race(1-5) gender(1) title = titlefile intro = introfile appendix = appA(Sample Description) appendix = appB(Description of Weighting Procedures)
study = natlrace varlist = rvarlist rowvar=year savefile = race template = template.cb title = titlefile intro = general(General Introduction to the Study) intro = sponsors(Organization and Funding of the Study) appendix = note1(Codes for States and Countries) appendix = note2(Codes for Religious Denominations) # The following headings go in the body of the codebook # as well as in the index (because of the ’**’). appendix = appA(**Sample Description) appendix = appB(**Description of Weighting Procedures) appendix = appC(**Outcome of Fieldwork)
type = html idl = sipp.idl title = mytitlefile savefile = sipp intro = general(General Introduction to the Study) intro = sponsors(Organization and Funding of the Study) # The following headings go in the body of the codebook # as well as in the index (because of the ’**’). appendix = appA(**Sample Description) appendix = appB(**Description of Weighting Procedures)
| xcodebk formatting | Summary of formatting instructions for XCODEBK |
| xcodebk IDOC | Produce an Instrument Document |